package com.pi4j.io.w1;

/*
 * #%L
 * **********************************************************************
 * ORGANIZATION  :  Pi4J
 * PROJECT       :  Pi4J :: Java Library (Core)
 * FILENAME      :  W1DeviceType.java
 *
 * This file is part of the Pi4J project. More information about
 * this project can be found here:  https://pi4j.com/
 * **********************************************************************
 * %%
 * Copyright (C) 2012 - 2021 Pi4J
 * %%
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * #L%
 */

import java.io.File;

/**
 *
 * http://en.wikipedia.org/wiki/1-Wire
 * @author Peter Schuebl
 */
public interface W1DeviceType {

    /**
     * Returns the FID of the W1 device e.g. 0x28 for DS18B20
     *
     * Each device has 48 bit (six bytes) globally unique address where last eight bits are
     * CRC of first 56 bits. First byte stores a device family code, that identifies device type.
     *
     * @return the family id of the device
     */
    int getDeviceFamilyCode();

    /**
     * Gets the implementation class of the device which must be a sub-class of W1Device
     * @return the implementation class
     */
    Class<? extends W1Device> getDeviceClass();

    /**
     * Creates a new instance of a concrete device.
     * @param deviceDir
     * @return
     */
    W1Device create(File deviceDir);

}
